Management API

Base Resource URL:


                    https://[server-name]/api/v01/customers/[customer-id]/transactions

Description:

Provides access to the transactions associated with the specified customer.

Available sub-resources:

Resource URL	Description
https://[server-name]/api/v01/customers/[customer-id]/transactions/[transaction-id]	Provides access to management of the specified transaction.

Supported Actions:

create

Method: PUT	Implicit: Yes	Returns: Transaction *
Consumes: json, xml		Produces: json, xml

Create transactions to automatically generate invoice records linked to customers and track payment activities. Transactions provide a complete history of all financial operations associated with each customer account.\n\r\n> Note: Transactions are automatically linked to the merchant account that processes them. Each transaction contains details about the payment method, amount, and status.\n\r\n> Warning: Transactions should not be confused with real-time payment processing. For one-time payments or on-demand transactions (triggered manually or via API), use the Transaction API instead of the Billing API.\n\r\n> Tip: Subscribe to NOC and return webhooks when processing Direct Debit (ACH) transactions to receive real-time updates on account changes and transaction status. See Webhooks Management guide for implementation details.

Parameters:

#	Name	Type	Required	Default	Description
01	object	Transaction *	Yes		Represents a transaction associated with a particular merchant.

find

Method: GET	Implicit: Yes	Returns: Transaction[] *
Consumes: xurl		Produces: json, xml

Returns a list of the transactions associated with the specified customer.

Parameters:

#	Name	Type	Required	Default	Description
01	offset	Integer	No	0	Index of the first record returned from the search result.\n\r\n> Note: Default value is 0. Used with limit parameter for pagination.\n\r\n> Tip: Use this field for implementing paginated results. See Error Messages section for details on pagination issues.
02	limit	Integer	No	100	Maximum number of records to load per search call.\n\r\n> Note: Default value is 100. Adjust based on performance requirements.\n\r\n> Tip: Use this field to balance response size and performance. See Webhooks Management Guide for details on handling large datasets.
03	createDateFrom	Date	No		The starting date for filtering transaction records; only records dated from this specific day onwards are included.
04	createDateTo	Date	No		The concluding date for filtering transaction records; only records up to and through this specified date are included.

process

Method: POST	Implicit: No	Returns: Transaction *
Consumes: json, xml		Produces: json, xml

Creates and processes a transaction associated with the specified customer.

Parameters:

#	Name	Type	Required	Default	Description
01	object	ProcessingRequest *	Yes		Represents information included in processing request sent to a processor.